#!/usr/bin/perl 
################################################
# Helpfile for dataGen.pl
#
#
################################################

print "\n**********************************************************\n";
print "**********************************************************\n";
print "\n USAGE: ";
print "./dataGen.pl <PARAMETER FILE>\n";
print "\n**********************************************************\n";
print "**********************************************************\n";
print "\n\n",
    "-----------------------------------------------------------\n",
    " Parameter File...\n",
    " -DESC: asci file containing a list of parameters in the   \n",
    "        order described below followed optionally with a   \n",
    "        comment starting with a # character. Lines         \n",
    "        starting with a '#' will also be ignored.          \n",
    "                                                           \n",
    "  <length>          # length of time series\n",   
    "  <start> <stop>    # time range\n",
    "  <E|R|D|N|RN|SF>   # 'E'ven or 'R'andom sampling \n",
    "                    # 'D'uty cycle 'N'oise addition \n",
    "                    # 'RN' is a combination of random and noise \n",
    "                    # 'SF' spacing determined by spacing file \n",
    "  [% random drops]  # *if* random sampling, % to drop\n",
    "  [spacing file]    # name of spacing file\n",
    "  <# components>    # number of components in series\n",
    "  <component n   = (amp freq phase) >\n",
    "  <component n+1 = (amp freq phase) >\n",
    "  < ... >\n",
    "\n",
    "-----------------------------------------------------------\n",
    " Output File(s)... \n",
    " -DESC: asci file containing a sample time series generated\n",
    "        in accordance to Paramter file and an associated   \n",
    "        header file containing a summary table.            \n",
    "        The time series is formatted in 2 column:, time and\n",
    "        amplitude. \n",
    "\n",
    "        < time1 >  < amplitude1 >\n",
    "        < time2 >  < amplitude2 >\n",
    "        <  ...  >  <      ...   >\n",
    "\n",
    "\n";
